Doc: small fixes in GtkTextView
authorSébastien Wilmet <swilmet@gnome.org>
Tue, 10 Sep 2013 12:23:28 +0000 (14:23 +0200)
committerSébastien Wilmet <swilmet@gnome.org>
Sat, 14 Sep 2013 19:45:00 +0000 (21:45 +0200)
Move GtkWrapMode from GtkTextTag to the GtkTextView section. The wrap
mode property is in the text view.

Links to the "mark-set" and "mark-deleted" signals.

Add a precision about gtk_text_buffer_get_iter_at_line().

Fix typo in gtk_text_tag_set_priority().

https://bugzilla.gnome.org/show_bug.cgi?id=708076

docs/reference/gtk/gtk3-sections.txt
gtk/gtktextbuffer.c
gtk/gtktexttag.c

index 12e0825444cd27447f987a7ee0d76cab91fcb451..531f05e528df5e46417d350570ca8bf0834a62bc 100644 (file)
@@ -3704,7 +3704,6 @@ gtk_text_mark_get_type
 <FILE>gtktexttag</FILE>
 <TITLE>GtkTextTag</TITLE>
 GtkTextTag
-GtkWrapMode
 gtk_text_tag_new
 gtk_text_tag_get_priority
 gtk_text_tag_set_priority
@@ -3757,6 +3756,7 @@ gtk_text_tag_table_get_type
 <TITLE>GtkTextView</TITLE>
 GtkTextView
 GtkTextWindowType
+GtkWrapMode
 gtk_text_view_new
 gtk_text_view_new_with_buffer
 gtk_text_view_set_buffer
index c1266724a71a98a117dcd9ae358879617ecb8ec8..c11308089d6b25a4d39dfad70c81c74443160727 100644 (file)
@@ -2111,8 +2111,8 @@ gtk_text_buffer_set_mark (GtkTextBuffer     *buffer,
  * return value if you like. Marks are owned by the buffer and go 
  * away when the buffer does.
  *
- * Emits the "mark-set" signal as notification of the mark's initial
- * placement.
+ * Emits the #GtkTextBuffer::mark-set signal as notification of the mark's
+ * initial placement.
  *
  * Return value: (transfer none): the new #GtkTextMark object
  **/
@@ -2138,8 +2138,8 @@ gtk_text_buffer_create_mark (GtkTextBuffer     *buffer,
  * another buffer, and if its name is not %NULL then there must not
  * be another mark in the buffer with the same name.
  *
- * Emits the "mark-set" signal as notification of the mark's initial
- * placement.
+ * Emits the #GtkTextBuffer::mark-set signal as notification of the mark's
+ * initial placement.
  *
  * Since: 2.12
  **/
@@ -2172,8 +2172,8 @@ gtk_text_buffer_add_mark (GtkTextBuffer     *buffer,
  * @mark: a #GtkTextMark
  * @where: new location for @mark in @buffer
  *
- * Moves @mark to the new location @where. Emits the "mark-set" signal
- * as notification of the move.
+ * Moves @mark to the new location @where. Emits the #GtkTextBuffer::mark-set
+ * signal as notification of the move.
  **/
 void
 gtk_text_buffer_move_mark (GtkTextBuffer     *buffer,
@@ -2221,7 +2221,7 @@ gtk_text_buffer_get_iter_at_mark (GtkTextBuffer *buffer,
  * invalid, until it gets added to a buffer again with 
  * gtk_text_buffer_add_mark(). Use gtk_text_mark_get_deleted() to  
  * find out if a mark has been removed from its buffer.
- * The "mark-deleted" signal will be emitted as notification after 
+ * The #GtkTextBuffer::mark-deleted signal will be emitted as notification after
  * the mark is deleted.
  **/
 void
@@ -2911,8 +2911,9 @@ gtk_text_buffer_get_iter_at_line_index  (GtkTextBuffer *buffer,
  * @buffer: a #GtkTextBuffer 
  * @iter: (out): iterator to initialize
  * @line_number: line number counting from 0
- * 
- * Initializes @iter to the start of the given line.
+ *
+ * Initializes @iter to the start of the given line. If @line_number is greater
+ * than the number of lines in the @buffer, the end iterator is returned.
  **/
 void
 gtk_text_buffer_get_iter_at_line (GtkTextBuffer *buffer,
index 2cdd88f171d02b1fe9b72aefe3c06d25c4f7302e..2462f736a985b91241116dada2bbcd5aa2342e26 100644 (file)
@@ -1907,8 +1907,8 @@ gtk_text_tag_get_priority (GtkTextTag *tag)
  * gtk_text_tag_set_priority:
  * @tag: a #GtkTextTag
  * @priority: the new priority
- * 
- * Sets the priority of a #GtkTextTag. Valid priorities are
+ *
+ * Sets the priority of a #GtkTextTag. Valid priorities
  * start at 0 and go to one less than gtk_text_tag_table_get_size().
  * Each tag in a table has a unique priority; setting the priority
  * of one tag shifts the priorities of all the other tags in the